<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!--
(C) Copyright MarketLive. 2006. All rights reserved.
MarketLive is a trademark of MarketLive, Inc.
Warning: This computer program is protected by copyright law and international treaties.
Unauthorized reproduction or distribution of this program, or any portion of it, may result
in severe civil and criminal penalties, and will be prosecuted to the maximum extent
possible under the law.
-->
</head>
<body bgcolor="white">

Abstract implementation of the entity-home-primary key pattern intended for use
with Hibernate as the persistence layer.
<p/>
The <code>Entity</code> and <code>EntityHome</code> patterns are intended to be
extended by concrete subclasses.  Each entity is placed in a subpackage with
the package name matching the entity name (in lowercase).
<p/>
The <code>StringPk</code> and <code>IntegerPk</code> implementations of
<code>IPrimaryKey</code> can be used for entities with simple keys of <code>String</code>
and <code>int</code> respectively.  For entities with compound keys, an implementation of
<code>IPrimaryKey</code> is required.
<p>
The implementation of IPrimaryKey.getAsString() and EntityHome.getPk(String)
must be such that if:
<pre>
String s = pk.getAsString();
IPrimaryKey pk2 = home.getPk(s);
</pre>
then
<pre>
pk.equals(pk2)
</pre>
must be true.
<!-- Put @see and @since tags down here. -->

</body>
</html>
